home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 May / Macworld (1998-05).dmg / Shareware World / Comms & Internet / ProTERM_1.2.5.Install / ProTERM Mac1.2.5 / Help / Indexing Help < prev    next >
Text File  |  1998-02-13  |  8KB  |  103 lines

  1. **** ProTERM HELP FILE ****
  2.      =================
  3.  
  4. **** PTMM Indexing Help ****
  5.  
  6. **** Quick Index ****
  7.  
  8.  • ProTERM's Quick Index is available for this document.
  9.    When this file is opened from a ProTERM Help menu, a small table of
  10.    contents or "Index" window also opens to the right of this window: ===>>
  11.    Double-click any subject header in the Quick Index window to locate that
  12.    subject header here. Use the Quick Index window as a quick navigator tool.
  13.  
  14.  • Create Quick Indexes for your own ProTERM documents. For help on this
  15.    and other features, choose Help from the Apple menu (upper left corner).
  16. ** ——— **
  17.  
  18. *** Formatting Note ***
  19.  
  20. When ProTERM documents are opened via the Help menu, or if save appears in a noticeably different format than if you open the document directly from the Help folder. Comparing the two methods of viewing the file demonstrates some of ProTERM’s special features: Both Index formatting and Dot-command formatting are used, and you can see the result of the formatting by comparing the files. 
  21.  
  22. ** Indexed Files **
  23.  
  24. In addition to having a different format, when the file is opened from the Help menu, you will also see an additional window, this small window is called a windoid, and it contains an “Indexed” outline of the subject leaders in this document. Windoids are application sensitive, are always the topmost object and cannot be hidden behind any window used in that same application. This means when ProTERM is being used, and a windoid is open, it will be the top-most document. Windoids can be moved, resized and closed, and they remember their size and position when reopened. To move the windoid, click and drag the windoid’s title bar, to resize, click and drag the grow box (lower right corner), and to close, click the close box (upper left corner).
  25.  
  26. Why are the windoids there? Double-click on one of the indexed items (lines) in the windoid, and that subject will be found and marked in the main document. Note that the subject leader that was found and is selected, has a number of asterisks leading and trailing the header. See an explanation with examples of this index formatting later in this document.
  27.  
  28. As noted, the formatting is noticeably different when you open this document directly from the Help folder. When the document is opened from the Help folder instead of from the Help menu, you will not see the windoid, and you will not see the special formatting that takes place when the file is opened from the Help menu. You will see the visible formatting commands. This is due to ProTERM’s Indexing routine, and special formatting that takes place when the document is opened from the Help menu (or by using Format Test from the Edit menu, or by changing the document file type). For more detail on these features, contact InTrec Technical Support. Also see ProTERM > Help > KwikRef PTMac; Subject header — ProTERM Filetypes
  29.  
  30. ** Create Your Own Help Files **
  31.  
  32. You can create your own personal help or address files, save them in this folder, and they will show up after you restart ProTERM. Other than dragging and dropping text from another document, Help menu files cannot be altered. To create or alter a file to be used in the Help menu, open the file directly from the Help folder, not through the Help menu. To further protect the document from alteration, the file can be locked using the Get Info command.
  33.  
  34. Another example of these kinds of files applies to school use where a student would call into a school’s central online service and use files from the Help menu for lists of answers or replies to drag and drop onto an answer form.
  35.  
  36. ** Help File Examples **
  37. To create your own Help file or email address or Web site address file:
  38. ºlm3ººpm-2º
  39. 1 Choose New from the File .
  40. 2 Type your text or list, and save the file to the Help folder.
  41. 3 Quit and restart ProTERM, and your file will be available in the Help menu.
  42. ºlmººpmº
  43.  
  44. You can select text, and drag the selection to another window. For example, if you created a file with all of your popular email addresses or URLs (Web site addresses), you could open your special address file in the Help menu, select the desired text, and drag the selection to the appropriate place in your document, or to the terminal window where it will paste at the cursor position in the terminal window.
  45.  
  46. ** Self Indexing **
  47. Any file placed in the Help file can be self indexing when read from the Help menu:
  48. ºlm3ººpm-2º
  49. • Place a quantity of asterisks before and after the indexed text.
  50. • The same number of asterisks must be on both sides.
  51. • There must be one space between the text and the asterisks.
  52.    Example: ** This an Example **
  53. • The leading (left) asterisks must touch the left margin.
  54. • The maximum number of characters between asterisks is 31.
  55. • As in any proper outline, the maximum off-set (number of asterisks is always used at the top of the outline, then subsequent indents, or steps of the outline always follow. For example three asterisks, then two then one, never the reverse, i.e., one, two three. 
  56. • The indexed lines must be on a line by themselves.
  57. ºlmººpmº
  58.  
  59. The more asterisks used, the more weight given to the “outline-style” offset, (indent). For example, five asterisks would allow four subset indexes. In an example where five asterisks were used to offset the first entry, and then four additional graduated subentries (4 asterisk, 3 asterisk, 2 asterisk, 1 asterisk), were entered subsequent to the header, the text with the five asterisks would be shown in the Index windoid offset five spaces to the left from the lowest subset (a single set of asterisks). Four asterisks would offset four spaces to the right, three would offset three, etc. An indexed header starting with five asterisks as noted here would cause an index to look like this:
  60.  
  61. * Self Indexing Example *
  62. NOTE: The quotes used in this example “hide” this set so they are
  63.       just used as an example. Do not use quotes for actual indexing.
  64.  
  65. “***** Primary outline offset *****”  (The maximum used must be at the top)
  66. “**** Secondary outline offset ****”
  67. “*** Tertiary outline offset ***”
  68. “** Sub outline offset **”
  69. “* Sub-sub outline offset *”
  70.  
  71. The Index windoid would show the following.
  72. Five ASTERISK example
  73.  Four ASTERISK example
  74.   Three ASTERISK example
  75.    Two ASTERISK example
  76.     One ASTERISK example
  77.  
  78. You may only choose to use a one asterisk offset, or maybe two or three. They will work as long as you always have the primary offset (the offset with the most asterisks used in the document ahead of secondary or tertiary, offset titles). Note that a maximum of four asterisks are used in this document’s formatting because that quantity provided the required level of formatting needed for this document.
  79.  
  80. * Make Index Command *
  81. Experiment with the Indexing format and choose “Make Index” from the ProTERM Edit menu to test your work.
  82.  
  83. ** Dot-Command Formatting **
  84. For instructions on the special dot-command formatting used in this and other ProTERM documents, see the ProTERM Help menu: “Dot-Commands Defined”
  85.  
  86. ---
  87.  
  88. Let us know how ProTERM works for you.
  89.  
  90.  InTrec Software, Inc.   Sales ___________________        Tech ______
  91.  3035 E Topaz Circle     1888/PROTERM tollfree USA   Voc:602/992-1345
  92.  Phoenix, AZ 85028-4423  602/992-5515 outside USA    BBS:602/992-9789
  93.  Fax:602/992-0232        sales@intrec.com          proterm@intrec.com
  94.  URL <http://www.intrec.com>   FTP <ftp://ftp.intrec.com/pub/intrec/>
  95.    - Creative Macintosh and Apple II telecommunications solutions -
  96.  
  97. As always, if we can help... Ask! ;-)  Your questions help us add quality.
  98. Send a note to: proterm@intrec.com
  99.  
  100.  Last Updated: Feb 13, 1998
  101.  ©1994-98 InTrec Software, Inc.
  102.  Jerry Cline & Greg Schaefer
  103.